<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.HashMap;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.Map;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    /**<a name="line.6"></a>
<FONT color="green">007</FONT>     * A note class to store a specific note.<a name="line.7"></a>
<FONT color="green">008</FONT>     */<a name="line.8"></a>
<FONT color="green">009</FONT>    public class Note {<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>        /**<a name="line.11"></a>
<FONT color="green">012</FONT>         * An enum holding tones.<a name="line.12"></a>
<FONT color="green">013</FONT>         */<a name="line.13"></a>
<FONT color="green">014</FONT>        public enum Tone {<a name="line.14"></a>
<FONT color="green">015</FONT>            F((byte) -0x1, true),<a name="line.15"></a>
<FONT color="green">016</FONT>            G((byte) 0x1, true),<a name="line.16"></a>
<FONT color="green">017</FONT>            A((byte) 0x3, true),<a name="line.17"></a>
<FONT color="green">018</FONT>            B((byte) 0x5, false),<a name="line.18"></a>
<FONT color="green">019</FONT>            C((byte) 0x6, true),<a name="line.19"></a>
<FONT color="green">020</FONT>            D((byte) 0x8, true),<a name="line.20"></a>
<FONT color="green">021</FONT>            E((byte) 0xA, false);<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>            private final boolean sharpable;<a name="line.23"></a>
<FONT color="green">024</FONT>            private final byte id;<a name="line.24"></a>
<FONT color="green">025</FONT>            private static final Map&lt;Byte, Note.Tone&gt; tones = new HashMap&lt;Byte, Note.Tone&gt;();<a name="line.25"></a>
<FONT color="green">026</FONT>            /** The number of tones including sharped tones. */<a name="line.26"></a>
<FONT color="green">027</FONT>            public static final byte TONES_COUNT;<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>            private Tone(byte id, boolean sharpable) {<a name="line.29"></a>
<FONT color="green">030</FONT>                this.id = id;<a name="line.30"></a>
<FONT color="green">031</FONT>                this.sharpable = sharpable;<a name="line.31"></a>
<FONT color="green">032</FONT>            }<a name="line.32"></a>
<FONT color="green">033</FONT>    <a name="line.33"></a>
<FONT color="green">034</FONT>            /**<a name="line.34"></a>
<FONT color="green">035</FONT>             * Returns the not sharped id of this tone.<a name="line.35"></a>
<FONT color="green">036</FONT>             *<a name="line.36"></a>
<FONT color="green">037</FONT>             * @return the not sharped id of this tone.<a name="line.37"></a>
<FONT color="green">038</FONT>             */<a name="line.38"></a>
<FONT color="green">039</FONT>            public byte getId() {<a name="line.39"></a>
<FONT color="green">040</FONT>                return getId(false);<a name="line.40"></a>
<FONT color="green">041</FONT>            }<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>            /**<a name="line.43"></a>
<FONT color="green">044</FONT>             * Returns the id of this tone. These method allows to return the<a name="line.44"></a>
<FONT color="green">045</FONT>             * sharped id of the tone. If the tone couldn't be sharped it always<a name="line.45"></a>
<FONT color="green">046</FONT>             * return the not sharped id of this tone.<a name="line.46"></a>
<FONT color="green">047</FONT>             *<a name="line.47"></a>
<FONT color="green">048</FONT>             * @param sharped<a name="line.48"></a>
<FONT color="green">049</FONT>             *            Set to true to return the sharped id.<a name="line.49"></a>
<FONT color="green">050</FONT>             * @return the id of this tone.<a name="line.50"></a>
<FONT color="green">051</FONT>             */<a name="line.51"></a>
<FONT color="green">052</FONT>            public byte getId(boolean sharped) {<a name="line.52"></a>
<FONT color="green">053</FONT>                byte tempId = (byte) (sharped &amp;&amp; sharpable ? id + 1 : id);<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>                while (tempId &lt; 0) {<a name="line.55"></a>
<FONT color="green">056</FONT>                    tempId += TONES_COUNT;<a name="line.56"></a>
<FONT color="green">057</FONT>                }<a name="line.57"></a>
<FONT color="green">058</FONT>                return (byte) (tempId % TONES_COUNT);<a name="line.58"></a>
<FONT color="green">059</FONT>            }<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>            /**<a name="line.61"></a>
<FONT color="green">062</FONT>             * Returns if this tone could be sharped.<a name="line.62"></a>
<FONT color="green">063</FONT>             *<a name="line.63"></a>
<FONT color="green">064</FONT>             * @return if this tone could be sharped.<a name="line.64"></a>
<FONT color="green">065</FONT>             */<a name="line.65"></a>
<FONT color="green">066</FONT>            public boolean isSharpable() {<a name="line.66"></a>
<FONT color="green">067</FONT>                return sharpable;<a name="line.67"></a>
<FONT color="green">068</FONT>            }<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>            /**<a name="line.70"></a>
<FONT color="green">071</FONT>             * Returns if this tone id is the sharped id of the tone.<a name="line.71"></a>
<FONT color="green">072</FONT>             *<a name="line.72"></a>
<FONT color="green">073</FONT>             * @param id<a name="line.73"></a>
<FONT color="green">074</FONT>             *            the id of the tone.<a name="line.74"></a>
<FONT color="green">075</FONT>             * @return if the tone id is the sharped id of the tone.<a name="line.75"></a>
<FONT color="green">076</FONT>             * @throws IllegalArgumentException<a name="line.76"></a>
<FONT color="green">077</FONT>             *             if neither the tone nor the semitone have the id.<a name="line.77"></a>
<FONT color="green">078</FONT>             */<a name="line.78"></a>
<FONT color="green">079</FONT>            public boolean isSharped(byte id) {<a name="line.79"></a>
<FONT color="green">080</FONT>                if (id == getId(false)) {<a name="line.80"></a>
<FONT color="green">081</FONT>                    return false;<a name="line.81"></a>
<FONT color="green">082</FONT>                } else if (id == getId(true)) {<a name="line.82"></a>
<FONT color="green">083</FONT>                    return true;<a name="line.83"></a>
<FONT color="green">084</FONT>                } else {<a name="line.84"></a>
<FONT color="green">085</FONT>                    // The id isn't matching to the tone!<a name="line.85"></a>
<FONT color="green">086</FONT>                    throw new IllegalArgumentException("The id isn't matching to the tone.");<a name="line.86"></a>
<FONT color="green">087</FONT>                }<a name="line.87"></a>
<FONT color="green">088</FONT>            }<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>            /**<a name="line.90"></a>
<FONT color="green">091</FONT>             * Returns the tone to id. Also returning the semitones.<a name="line.91"></a>
<FONT color="green">092</FONT>             *<a name="line.92"></a>
<FONT color="green">093</FONT>             * @param id<a name="line.93"></a>
<FONT color="green">094</FONT>             *            the id of the tone.<a name="line.94"></a>
<FONT color="green">095</FONT>             * @return the tone to id.<a name="line.95"></a>
<FONT color="green">096</FONT>             */<a name="line.96"></a>
<FONT color="green">097</FONT>            public static Tone getToneById(byte id) {<a name="line.97"></a>
<FONT color="green">098</FONT>                return tones.get(id);<a name="line.98"></a>
<FONT color="green">099</FONT>            }<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>            static {<a name="line.101"></a>
<FONT color="green">102</FONT>                byte lowest = F.id;<a name="line.102"></a>
<FONT color="green">103</FONT>                byte highest = F.id;<a name="line.103"></a>
<FONT color="green">104</FONT>                for (Tone tone : Tone.values()) {<a name="line.104"></a>
<FONT color="green">105</FONT>                    byte id = tone.id;<a name="line.105"></a>
<FONT color="green">106</FONT>                    tones.put(id, tone);<a name="line.106"></a>
<FONT color="green">107</FONT>                    if (id &lt; lowest) {<a name="line.107"></a>
<FONT color="green">108</FONT>                        lowest = id;<a name="line.108"></a>
<FONT color="green">109</FONT>                    }<a name="line.109"></a>
<FONT color="green">110</FONT>                    if (tone.isSharpable()) {<a name="line.110"></a>
<FONT color="green">111</FONT>                        id++;<a name="line.111"></a>
<FONT color="green">112</FONT>                        tones.put(id, tone);<a name="line.112"></a>
<FONT color="green">113</FONT>                    }<a name="line.113"></a>
<FONT color="green">114</FONT>                    if (id &gt; highest) {<a name="line.114"></a>
<FONT color="green">115</FONT>                        highest = id;<a name="line.115"></a>
<FONT color="green">116</FONT>                    }<a name="line.116"></a>
<FONT color="green">117</FONT>                }<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>                TONES_COUNT = (byte) (highest - lowest + 1);<a name="line.119"></a>
<FONT color="green">120</FONT>                tones.put((byte) (TONES_COUNT - 1), F);<a name="line.120"></a>
<FONT color="green">121</FONT>            }<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        private final byte note;<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>        /**<a name="line.126"></a>
<FONT color="green">127</FONT>         * Creates a new note.<a name="line.127"></a>
<FONT color="green">128</FONT>         *<a name="line.128"></a>
<FONT color="green">129</FONT>         * @param note<a name="line.129"></a>
<FONT color="green">130</FONT>         *            Internal note id. {@link #getId()} always return this value.<a name="line.130"></a>
<FONT color="green">131</FONT>         *            The value has to be in the interval [0;&amp;nbsp;24].<a name="line.131"></a>
<FONT color="green">132</FONT>         */<a name="line.132"></a>
<FONT color="green">133</FONT>        public Note(byte note) {<a name="line.133"></a>
<FONT color="green">134</FONT>            if (note &lt; 0 || note &gt; 24) {<a name="line.134"></a>
<FONT color="green">135</FONT>                throw new IllegalArgumentException("The note value has to be between 0 and 24.");<a name="line.135"></a>
<FONT color="green">136</FONT>            }<a name="line.136"></a>
<FONT color="green">137</FONT>            this.note = note;<a name="line.137"></a>
<FONT color="green">138</FONT>        }<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>        /**<a name="line.140"></a>
<FONT color="green">141</FONT>         * Creates a new note.<a name="line.141"></a>
<FONT color="green">142</FONT>         *<a name="line.142"></a>
<FONT color="green">143</FONT>         * @param octave<a name="line.143"></a>
<FONT color="green">144</FONT>         *            The octave where the note is in. Has to be 0 - 2.<a name="line.144"></a>
<FONT color="green">145</FONT>         * @param note<a name="line.145"></a>
<FONT color="green">146</FONT>         *            The tone within the octave. If the octave is 2 the note has to<a name="line.146"></a>
<FONT color="green">147</FONT>         *            be F#.<a name="line.147"></a>
<FONT color="green">148</FONT>         * @param sharped<a name="line.148"></a>
<FONT color="green">149</FONT>         *            Set it the tone is sharped (e.g. for F#).<a name="line.149"></a>
<FONT color="green">150</FONT>         */<a name="line.150"></a>
<FONT color="green">151</FONT>        public Note(byte octave, Tone note, boolean sharped) {<a name="line.151"></a>
<FONT color="green">152</FONT>            if (sharped &amp;&amp; !note.isSharpable()) {<a name="line.152"></a>
<FONT color="green">153</FONT>                throw new IllegalArgumentException("This tone could not be sharped.");<a name="line.153"></a>
<FONT color="green">154</FONT>            }<a name="line.154"></a>
<FONT color="green">155</FONT>            if (octave &lt; 0 || octave &gt; 2 || (octave == 2 &amp;&amp; !(note == Tone.F &amp;&amp; sharped))) {<a name="line.155"></a>
<FONT color="green">156</FONT>                throw new IllegalArgumentException("Tone and octave have to be between F#0 and F#2");<a name="line.156"></a>
<FONT color="green">157</FONT>            }<a name="line.157"></a>
<FONT color="green">158</FONT>            this.note = (byte) (octave * Tone.TONES_COUNT + note.getId(sharped));<a name="line.158"></a>
<FONT color="green">159</FONT>        }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>        /**<a name="line.161"></a>
<FONT color="green">162</FONT>         * Returns the internal id of this note.<a name="line.162"></a>
<FONT color="green">163</FONT>         *<a name="line.163"></a>
<FONT color="green">164</FONT>         * @return the internal id of this note.<a name="line.164"></a>
<FONT color="green">165</FONT>         */<a name="line.165"></a>
<FONT color="green">166</FONT>        public byte getId() {<a name="line.166"></a>
<FONT color="green">167</FONT>            return note;<a name="line.167"></a>
<FONT color="green">168</FONT>        }<a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>        /**<a name="line.170"></a>
<FONT color="green">171</FONT>         * Returns the octave of this note.<a name="line.171"></a>
<FONT color="green">172</FONT>         *<a name="line.172"></a>
<FONT color="green">173</FONT>         * @return the octave of this note.<a name="line.173"></a>
<FONT color="green">174</FONT>         */<a name="line.174"></a>
<FONT color="green">175</FONT>        public int getOctave() {<a name="line.175"></a>
<FONT color="green">176</FONT>            return note / Tone.TONES_COUNT;<a name="line.176"></a>
<FONT color="green">177</FONT>        }<a name="line.177"></a>
<FONT color="green">178</FONT>    <a name="line.178"></a>
<FONT color="green">179</FONT>        private byte getToneByte() {<a name="line.179"></a>
<FONT color="green">180</FONT>            return (byte) (note % Tone.TONES_COUNT);<a name="line.180"></a>
<FONT color="green">181</FONT>        }<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>        /**<a name="line.183"></a>
<FONT color="green">184</FONT>         * Returns the tone of this note.<a name="line.184"></a>
<FONT color="green">185</FONT>         *<a name="line.185"></a>
<FONT color="green">186</FONT>         * @return the tone of this note.<a name="line.186"></a>
<FONT color="green">187</FONT>         */<a name="line.187"></a>
<FONT color="green">188</FONT>        public Tone getTone() {<a name="line.188"></a>
<FONT color="green">189</FONT>            return Tone.getToneById(getToneByte());<a name="line.189"></a>
<FONT color="green">190</FONT>        }<a name="line.190"></a>
<FONT color="green">191</FONT>    <a name="line.191"></a>
<FONT color="green">192</FONT>        /**<a name="line.192"></a>
<FONT color="green">193</FONT>         * Returns if this note is sharped.<a name="line.193"></a>
<FONT color="green">194</FONT>         *<a name="line.194"></a>
<FONT color="green">195</FONT>         * @return if this note is sharped.<a name="line.195"></a>
<FONT color="green">196</FONT>         */<a name="line.196"></a>
<FONT color="green">197</FONT>        public boolean isSharped() {<a name="line.197"></a>
<FONT color="green">198</FONT>            byte note = getToneByte();<a name="line.198"></a>
<FONT color="green">199</FONT>            return Tone.getToneById(note).isSharped(note);<a name="line.199"></a>
<FONT color="green">200</FONT>        }<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>    }<a name="line.202"></a>




























































</PRE>
</BODY>
</HTML>
